home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sspmv.z / sspmv
Encoding:
Text File  |  2002-10-03  |  18.9 KB  |  331 lines

  1.  
  2.  
  3.  
  4. SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))                                                            SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSSSSSPPPPMMMMVVVV, DDDDSSSSPPPPMMMMVVVV, CCCCSSSSPPPPMMMMVVVV, ZZZZSSSSPPPPMMMMVVVV - Multiplies a real or complex symmetric
  10.      packed matrix by a real or complex vector
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL SSSSSSSSPPPPMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a_p,,,, _x,,,, _i_n_c_x,,,, _b_e_t_a,,,, _y,,,, _i_n_c_y))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd ssssssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ffffllllooooaaaatttt _a_l_p_h_a,,,, ffffllllooooaaaatttt *_a_p,,,, ffffllllooooaaaatttt
  21.                *_x,,,, iiiinnnntttt _i_n_c_x,,,, ffffllllooooaaaatttt _b_e_t_a,,,, ffffllllooooaaaatttt *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                CCCCAAAALLLLLLLL DDDDSSSSPPPPMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a_p,,,, _x,,,, _i_n_c_x,,,, _b_e_t_a,,,, _y,,,, _i_n_c_y))))
  27.  
  28.           C/C++:
  29.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  30.                vvvvooooiiiidddd ddddssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee _a_l_p_h_a,,,, ddddoooouuuubbbblllleeee *_a_p,,,, ddddoooouuuubbbblllleeee
  31.                *_x,,,, iiiinnnntttt _i_n_c_x,,,, ddddoooouuuubbbblllleeee _b_e_t_a,,,, ddddoooouuuubbbblllleeee *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  32.  
  33.      Single precision complex
  34.  
  35.           Fortran:
  36.                CCCCAAAALLLLLLLL CCCCSSSSPPPPMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a_p,,,, _x,,,, _i_n_c_x,,,, _b_e_t_a,,,, _y,,,, _i_n_c_y))))
  37.  
  38.           C/C++:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  40.                vvvvooooiiiidddd ccccssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  41.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_p,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  42.                *_b_e_t_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  43.  
  44.           C++ STL:
  45.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  46.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  47.                vvvvooooiiiidddd ccccssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,,
  48.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_p,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  49.                *_b_e_t_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  50.  
  51.      Double precision complex
  52.  
  53.           Fortran:
  54.                CCCCAAAALLLLLLLL ZZZZSSSSPPPPMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a_p,,,, _x,,,, _i_n_c_x,,,, _b_e_t_a,,,, _y,,,, _i_n_c_y))))
  55.  
  56.           C/C++:
  57.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  58.                vvvvooooiiiidddd zzzzssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  59.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_p,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))                                                            SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.                *_b_e_t_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  75.  
  76.           C++ STL:
  77.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  78.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  79.                vvvvooooiiiidddd zzzzssssppppmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,,
  80.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_p,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  81.                *_b_e_t_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  82.  
  83. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  84.      These routines are part of the SCSL Scientific Library and can be loaded
  85.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  86.      directs the linker to use the multi-processor version of the library.
  87.  
  88.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  89.      4 bytes (32 bits). Another version of SCSL is available in which integers
  90.      are 8 bytes (64 bits).  This version allows the user access to larger
  91.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  92.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  93.      only one of the two versions; 4-byte integer and 8-byte integer library
  94.      calls cannot be mixed.
  95.  
  96.      The C and C++ prototypes shown above are appropriate for the 4-byte
  97.      integer version of SCSL. When using the 8-byte integer version, the
  98.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  99.      file should be included.
  100.  
  101. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  102.      These routines perform the following matrix-vector operation:
  103.  
  104.           _y <-_a_l_p_h_a _A_x +  _b_e_t_a _y
  105.  
  106.      where _a_l_p_h_a and _b_e_t_a are scalars, _x and _y are _n-element vectors, and _A is
  107.      an _n-by-_n symmetric packed matrix.
  108.  
  109.      See the NOTES section of this man page for information about the
  110.      interpretation of the data types described in the following arguments.
  111.  
  112.      These routines have the following arguments:
  113.  
  114.      _u_p_l_o      Character.  (input)
  115.                Specifies whether the upper or lower triangular part of matrix
  116.                _A is packed into the array argument _a_p, as follows:
  117.  
  118.                _u_p_l_o= 'U' or 'u':  the upper triangular part of _A is being
  119.                supplied in the argument _a_p.
  120.                _u_p_l_o= 'L' or 'l':  the lower triangular part of _A is being
  121.                supplied in the argument _a_p.
  122.  
  123.                For C/C++, a pointer to this character is passed.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))                                                            SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      _n         Integer.  (input)
  141.                Specifies the order of matrix _A.  _n >= 0.
  142.  
  143.      _a_l_p_h_a     Scalar alpha.  (input)
  144.                SSSSSSSSPPPPMMMMVVVV: Single precision.
  145.                DDDDSSSSPPPPMMMMVVVV: Double precision.
  146.                CCCCSSSSPPPPMMMMVVVV: Single precision complex.
  147.                ZZZZSSSSPPPPMMMMVVVV: Double precision complex.
  148.  
  149.                For C/C++, a pointer to this scalar is passed when alpha is
  150.                complex; otherwise, alpha is passed by value.
  151.  
  152.      _a_p        Array of dimension (_n(_n+1))/2  (input)
  153.                SSSSSSSSPPPPMMMMVVVV: Single precision array.
  154.                DDDDSSSSPPPPMMMMVVVV: Double precision array.
  155.                CCCCSSSSPPPPMMMMVVVV: Single precision complex array.
  156.                ZZZZSSSSPPPPMMMMVVVV: Double precision complex array.
  157.  
  158.                Before entry with _u_p_l_o = 'U' or 'u', array _a_p must contain the
  159.                upper triangular part of the symmetric matrix packed
  160.                sequentially, column-by-column, so that _a_p(1) contains _A(1,1),
  161.                _a_p(2) contains _A(1,2), _a_p(3) contains _A(2,2), and so on.
  162.  
  163.                Before entry with _u_p_l_o = 'L' or 'l', array _a_p must contain the
  164.                lower triangular part of the symmetric matrix packed
  165.                sequentially, column-by-column, so that _a_p(1) contains _A(1,1),
  166.                _a_p(2) contains _A(2,1), _a_p(3) contains _A(3,1), and so on.
  167.  
  168.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input)
  169.                SSSSSSSSPPPPMMMMVVVV: Single precision array.
  170.                DDDDSSSSPPPPMMMMVVVV: Double precision array.
  171.                CCCCSSSSPPPPMMMMVVVV: Single precision omplex array.
  172.                ZZZZSSSSPPPPMMMMVVVV: Double precision complex array.
  173.                Contains vector _x.
  174.  
  175.      _i_n_c_x      Integer.  (input)
  176.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  177.                be 0.
  178.  
  179.      _b_e_t_a      Scalar beta.  (input)
  180.                SSSSSSSSPPPPMMMMVVVV: Single precision.
  181.                DDDDSSSSPPPPMMMMVVVV: Double precision.
  182.                CCCCSSSSPPPPMMMMVVVV: Single precision complex.
  183.                ZZZZSSSSPPPPMMMMVVVV: Double precision complex.
  184.                If _b_e_t_a is supplied as 0, _y need not be set on input.
  185.  
  186.                For C/C++, a pointer to this scalar is passed when beta is
  187.                complex; otherwise, beta is passed by value.
  188.  
  189.      _y         Array of dimension 1+(_n-1) * |_i_n_c_y|.  (input and output)
  190.                SSSSSSSSPPPPMMMMVVVV: Single precision array.
  191.                DDDDSSSSPPPPMMMMVVVV: Double precision array.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))                                                            SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.                CCCCSSSSPPPPMMMMVVVV: Single precision complex array.
  207.                ZZZZSSSSPPPPMMMMVVVV: Double precision complex array.
  208.                Contains vector _y.  On exit, the updated vector overwrites
  209.                array _y.
  210.  
  211.      _i_n_c_y      Integer.  (input)
  212.                Specifies the increment for the elements of _y.  _i_n_c_y must not
  213.                be 0.
  214.  
  215. NNNNOOOOTTTTEEEESSSS
  216.      SSSSSSSSPPPPMMMMVVVV/DDDDSSSSPPPPMMMMVVVV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
  217.      CCCCSSSSPPPPMMMMVVVV/ZZZZSSSSPPPPMMMMVVVV is an extension to Level 2 BLAS.
  218.  
  219.      When working backward (_i_n_c_x < 0 or _i_n_c_y < 0), each routine starts at the
  220.      end of the vector and moves backward, as follows:
  221.  
  222.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)) , ..., _x(1)
  223.  
  224.           _y(1-_i_n_c_y * (_n-1)), _y(1-_i_n_c_y * (_n-2)) , ..., _y(1)
  225.  
  226.  
  227.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  228.      The following data types are described in this documentation:
  229.  
  230.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  231.  
  232.      Fortran:
  233.  
  234.           Array dimensioned _n           xxxx((((nnnn))))
  235.  
  236.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  237.  
  238.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  239.  
  240.           Single precision              RRRREEEEAAAALLLL
  241.  
  242.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  243.  
  244.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  245.  
  246.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  247.  
  248.      C/C++:
  249.  
  250.           Array dimensioned _n           xxxx[[[[_n]]]]
  251.  
  252.           Character                     cccchhhhaaaarrrr
  253.  
  254.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))                                                            SSSSSSSSPPPPMMMMVVVV((((3333SSSS))))
  269.  
  270.  
  271.  
  272.           Single precision              ffffllllooooaaaatttt
  273.  
  274.           Double precision              ddddoooouuuubbbblllleeee
  275.  
  276.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  277.  
  278.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  279.  
  280.      C++ STL:
  281.  
  282.           Array dimensioned _n           xxxx[[[[_n]]]]
  283.  
  284.           Character                     cccchhhhaaaarrrr
  285.  
  286.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  287.  
  288.           Single precision              ffffllllooooaaaatttt
  289.  
  290.           Double precision              ddddoooouuuubbbblllleeee
  291.  
  292.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  293.  
  294.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  295.  
  296.      Note that you can explicitly declare multidimensional C/C++ arrays
  297.      provided that the array dimensions are swapped with respect to the
  298.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  299.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  300.      message in C), however, the array should be cast to a pointer of the
  301.      appropriate type when passed as an argument to a SCSL routine.
  302.  
  303. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  304.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S), CCCCHHHHPPPPMMMMVVVV(3S)
  305.  
  306.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  307.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  308.      Linear Algebra Subprograms Technical Forum.
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.